Add localization keyword documentation - #13936
Merged
SAKavli merged 5 commits intoAug 20, 2026
Merged
Conversation
SAKavli
added
the
release-notes:documentation
SAKavli
force-pushed
the
add-localization-keyword-documentation
branch
from
July 3, 2026 06:34
c9ebe10 to
b6f4bdd
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #13936 +/- ##
==========================================
- Coverage 91.97% 91.97% -0.01%
==========================================
Files 484 484
Lines 33644 33672 +28
==========================================
+ Hits 30945 30969 +24
- Misses 2699 2703 +4
Flags with carried forward coverage won't be shown. Click here to find out more. |
xjules
reviewed
Aug 19, 2026
| configuration. These observations are therefore already correctly configured for distance | ||
| based localization. | ||
|
|
||
| The radius for RFTs will be the default radius value of 3000m, but can be overwritten by |
Contributor
There was a problem hiding this comment.
Can EAST and NORTH be overwritten too?
Contributor
Author
There was a problem hiding this comment.
For normal observation declarations, e.g. from_dict from obs config: yes
For observations loaded from csv: no
For normal observations, I now see that there is a "race condition" of what will be the north and east values, based on what is processed first:
for key, value in observation_dict.items():
match key:
case "type" | "name":
pass
case "WELL":
well = value
case "PROPERTY":
observed_property = value
case "VALUE":
observed_value = validate_float(value, key)
case "ERROR":
error = validate_float(value, key)
case "DATE":
date = value
case "NORTH":
north = validate_float(value, key)
case "EAST":
east = validate_float(value, key)
case "TVD":
tvd = validate_float(value, key)
case "CSV":
csv_filename = value
case "ZONE":
zone = value
case "MD":
md = validate_float(value, key)
case "LOCALIZATION":
validate_rft_localization(value, observation_dict.context)
east, north, radius = extract_localization_values(value)
radius = (
radius if radius is not None else DEFAULT_LOCALIZATION_RADIUS
)
case _:
raise _unknown_key_error(str(key), observation_dict.context)Not great perhaps.
Contributor
Author
There was a problem hiding this comment.
Just checked this, validate_rft_localization raises an error if NORTH or EAST are defined under the LOCALIZATION block
SAKavli
force-pushed
the
add-localization-keyword-documentation
branch
from
August 19, 2026 13:11
b6f4bdd to
fa7c1d4
Compare
xjules
reviewed
Aug 19, 2026
|
|
||
| LOCALIZATION contains two required fields: NORTH and EAST, and optionally | ||
| RADIUS. These localization attributes will be applied to all observations | ||
| sharing the same well name as the WELL configuration. |
Contributor
There was a problem hiding this comment.
maybe an example how to specify the well inside an observation.
SAKavli
force-pushed
the
add-localization-keyword-documentation
branch
2 times, most recently
from
August 19, 2026 14:23
02722fd to
3ffee1a
Compare
xjules
approved these changes
Aug 19, 2026
It is unclear what this was trying to describe, but it's obvious that it has lost its example and has therefore lost its purpose.
The LOCALIZATION keyword is already referenced in the documentation for the bulk config without existing, so its time to add some documentation for this keyword.
This will link to the BREAKTHROUGH observation section and the LOCALIZATION keyword section in the places where they are referenced from the bulk configuration documentation.
It's nice to have all the observation types gathered in one place.
Sections which are appending information to an existing section looks nice in the table of contents on the sidebar. They appear indented under the main section, in this case summary observations.
SAKavli
force-pushed
the
add-localization-keyword-documentation
branch
from
August 20, 2026 07:41
3ffee1a to
ca82eb8
Compare
Contributor
Author
|
I have force pushed to update to the commit bodies. |
SAKavli
enabled auto-merge (rebase)
August 20, 2026 07:43
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
Resolves #12671
Approach
Short description of the approach
(Screenshot of new behavior in GUI if applicable)
git rebase -i main --exec 'just rapid-tests')When applicable